Improve docs. (#446138, Björn Lindqvist)

2007-06-12  Behdad Esfahbod  <behdad@gnome.org>

        * gdk/gdkwindow.c (gdk_window_get_pointer): Improve docs.
        (#446138, Björn Lindqvist)

svn path=/trunk/; revision=18109

diff --git a/ChangeLog b/ChangeLog
index c20d322d04c0f458e181fbd04a33355f13e48b90..52860d823d54b78392e5c18cf7fd0ced1542cfb8 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-06-12  Behdad Esfahbod  <behdad@gnome.org>
+
+       * gdk/gdkwindow.c (gdk_window_get_pointer): Improve docs.
+       (#446138, Björn Lindqvist)
+
 2007-06-12  Yevgen Muntyan  <muntyan@tamu.edu>
 
        * gtk/gtkentry.c (gtk_entry_expose), (gtk_entry_toggle_overwrite),

diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c
index a4f0140f018b82fb0942041b741447a65b1dcb5b..e07f5d9cf2152f008e5506f10be061305985ddfd 100644 (file)
--- a/gdk/gdkwindow.c
+++ b/gdk/gdkwindow.c
@@ -2977,9 +2977,12 @@ gdk_window_constrain_size (GdkGeometry *geometry,
 /**
  * gdk_window_get_pointer:
  * @window: a #GdkWindow
- * @x: return location for X coordinate of pointer
- * @y: return location for Y coordinate of pointer
- * @mask: return location for modifier mask
+ * @x: return location for X coordinate of pointer or %NULL to not
+ *      return the X coordinate
+ * @y: return location for Y coordinate of pointer or %NULL to not
+ *      return the Y coordinate
+ * @mask: return location for modifier mask or %NULL to not return the
+ *      modifier mask
  *
  * Obtains the current pointer position and modifier state.
  * The position is given in coordinates relative to the upper left